<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.4"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Flow: flow::perf::Checkpointing_timer::Checkpoint Struct Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr id="projectrow">
  <td id="projectalign">
   <div id="projectname">Flow<span id="projectnumber">&#160;2.0.0</span>
   </div>
   <div id="projectbrief">Flow project: Public API.</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.4 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search",'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="namespaceflow.html">flow</a></li><li class="navelem"><a class="el" href="namespaceflow_1_1perf.html">perf</a></li><li class="navelem"><a class="el" href="classflow_1_1perf_1_1Checkpointing__timer.html">Checkpointing_timer</a></li><li class="navelem"><a class="el" href="structflow_1_1perf_1_1Checkpointing__timer_1_1Checkpoint.html">Checkpoint</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="#related">Related Functions</a> &#124;
<a href="structflow_1_1perf_1_1Checkpointing__timer_1_1Checkpoint-members.html">List of all members</a>  </div>
  <div class="headertitle"><div class="title">flow::perf::Checkpointing_timer::Checkpoint Struct Reference</div></div>
</div><!--header-->
<div class="contents">

<p>The entirety of the information recorded with each <a class="el" href="classflow_1_1perf_1_1Checkpointing__timer.html#a9e6078df059d5626ab5774f0a33fbad7" title="Records a checkpoint, which takes a sample of all enabled Clock_types&#39; clocks and records the corresp...">Checkpointing_timer::checkpoint()</a> call; it contains the <code>Duration</code> values (for each <code>Clock_type</code>) with the time elapsed since either the preceding <code>T.checkpoint()</code> or construction.  
 <a href="structflow_1_1perf_1_1Checkpointing__timer_1_1Checkpoint.html#details">More...</a></p>

<p><code>#include &lt;checkpt_timer.hpp&gt;</code></p>
<div class="dynheader">
Collaboration diagram for flow::perf::Checkpointing_timer::Checkpoint:</div>
<div class="dyncontent">
<div class="center"><iframe scrolling="no" frameborder="0" src="structflow_1_1perf_1_1Checkpointing__timer_1_1Checkpoint__coll__graph.svg" width="170" height="131"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe>
</div>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-attribs" name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:a6c0363e3e1ef330464b87363e4287758"><td class="memItemLeft" align="right" valign="top"><a id="a6c0363e3e1ef330464b87363e4287758" name="a6c0363e3e1ef330464b87363e4287758"></a>
const std::string&#160;</td><td class="memItemRight" valign="bottom"><b>m_name</b></td></tr>
<tr class="memdesc:a6c0363e3e1ef330464b87363e4287758"><td class="mdescLeft">&#160;</td><td class="mdescRight">User-supplied name of the checkpoint. <br /></td></tr>
<tr class="separator:a6c0363e3e1ef330464b87363e4287758"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aacbec1a1e5600aeac4e7ca876060552f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structflow_1_1perf_1_1Duration__set.html">Duration_set</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structflow_1_1perf_1_1Checkpointing__timer_1_1Checkpoint.html#aacbec1a1e5600aeac4e7ca876060552f">m_since_last</a></td></tr>
<tr class="memdesc:aacbec1a1e5600aeac4e7ca876060552f"><td class="mdescLeft">&#160;</td><td class="mdescRight">For the <code>T.checkpoint()</code> call that generated <code>*this</code>, for each enabled <code>Clock_type</code>: Time elapsed since either the preceding <code>T.checkpoint()</code> or (if it's the first <code>T.checkpoint()</code>) since <code>T</code> construction.  <a href="structflow_1_1perf_1_1Checkpointing__timer_1_1Checkpoint.html#aacbec1a1e5600aeac4e7ca876060552f">More...</a><br /></td></tr>
<tr class="separator:aacbec1a1e5600aeac4e7ca876060552f"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="related" name="related"></a>
Related Functions</h2></td></tr>
<tr><td class="ititle" colspan="2"><p >(Note that these are not member functions.) </p>
</td></tr>
<tr class="memitem:a5bb3a068357516df714c4266ec5c3df4"><td class="memItemLeft" align="right" valign="top">std::ostream &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structflow_1_1perf_1_1Checkpointing__timer_1_1Checkpoint.html#a5bb3a068357516df714c4266ec5c3df4">operator&lt;&lt;</a> (std::ostream &amp;os, const <a class="el" href="structflow_1_1perf_1_1Checkpointing__timer_1_1Checkpoint.html">Checkpointing_timer::Checkpoint</a> &amp;<a class="el" href="classflow_1_1perf_1_1Checkpointing__timer.html#a9e6078df059d5626ab5774f0a33fbad7">checkpoint</a>)</td></tr>
<tr class="memdesc:a5bb3a068357516df714c4266ec5c3df4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Prints string representation of the given <code><a class="el" href="structflow_1_1perf_1_1Checkpointing__timer_1_1Checkpoint.html" title="The entirety of the information recorded with each Checkpointing_timer::checkpoint() call; it contain...">Checkpoint</a></code> to the given <code>ostream</code>.  <a href="structflow_1_1perf_1_1Checkpointing__timer_1_1Checkpoint.html#a5bb3a068357516df714c4266ec5c3df4">More...</a><br /></td></tr>
<tr class="separator:a5bb3a068357516df714c4266ec5c3df4"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p >The entirety of the information recorded with each <a class="el" href="classflow_1_1perf_1_1Checkpointing__timer.html#a9e6078df059d5626ab5774f0a33fbad7" title="Records a checkpoint, which takes a sample of all enabled Clock_types&#39; clocks and records the corresp...">Checkpointing_timer::checkpoint()</a> call; it contains the <code>Duration</code> values (for each <code>Clock_type</code>) with the time elapsed since either the preceding <code>T.checkpoint()</code> or construction. </p>
<p >User doesn't usually need to access these, since the string/stream/log facilities of <a class="el" href="classflow_1_1perf_1_1Checkpointing__timer.html" title="The central class in the perf Flow module, this efficiently times the user&#39;s operation,...">Checkpointing_timer</a> and <a class="el" href="classflow_1_1perf_1_1Checkpointing__timer_1_1Aggregator.html" title="This companion/inner class of Checkpointing_timer provides aggregation of results from many Checkpoin...">Checkpointing_timer::Aggregator</a> would already print out the info; but this provides programmatic access if desired. </p>
</div><h2 class="groupheader">Friends And Related Function Documentation</h2>
<a id="a5bb3a068357516df714c4266ec5c3df4" name="a5bb3a068357516df714c4266ec5c3df4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5bb3a068357516df714c4266ec5c3df4">&#9670;&nbsp;</a></span>operator&lt;&lt;()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">std::ostream &amp; operator&lt;&lt; </td>
          <td>(</td>
          <td class="paramtype">std::ostream &amp;&#160;</td>
          <td class="paramname"><em>os</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const <a class="el" href="structflow_1_1perf_1_1Checkpointing__timer_1_1Checkpoint.html">Checkpointing_timer::Checkpoint</a> &amp;&#160;</td>
          <td class="paramname"><em>checkpoint</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">related</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Prints string representation of the given <code><a class="el" href="structflow_1_1perf_1_1Checkpointing__timer_1_1Checkpoint.html" title="The entirety of the information recorded with each Checkpointing_timer::checkpoint() call; it contain...">Checkpoint</a></code> to the given <code>ostream</code>. </p>
<p >See <a class="el" href="classflow_1_1perf_1_1Checkpointing__timer.html#a9e6078df059d5626ab5774f0a33fbad7" title="Records a checkpoint, which takes a sample of all enabled Clock_types&#39; clocks and records the corresp...">Checkpointing_timer::checkpoint()</a> and <a class="el" href="classflow_1_1perf_1_1Checkpointing__timer.html#a1f03d654924a3724e1f051c119f3767b" title="Returns the checkpoints recorded so far.">Checkpointing_timer::checkpoints()</a>.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">os</td><td>Stream to which to write. </td></tr>
    <tr><td class="paramname">checkpoint</td><td>Object to serialize. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><code>os</code>. </dd></dl>

</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="aacbec1a1e5600aeac4e7ca876060552f" name="aacbec1a1e5600aeac4e7ca876060552f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aacbec1a1e5600aeac4e7ca876060552f">&#9670;&nbsp;</a></span>m_since_last</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="structflow_1_1perf_1_1Duration__set.html">Duration_set</a> flow::perf::Checkpointing_timer::Checkpoint::m_since_last</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>For the <code>T.checkpoint()</code> call that generated <code>*this</code>, for each enabled <code>Clock_type</code>: Time elapsed since either the preceding <code>T.checkpoint()</code> or (if it's the first <code>T.checkpoint()</code>) since <code>T</code> construction. </p>
<p >Zero is recorded for each disabled <code>Clock_type</code>. </p>

</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li>perf/<a class="el" href="checkpt__timer_8hpp.html">checkpt_timer.hpp</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Fri Mar 28 2025 22:55:32 for Flow by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.4
</small></address>
</body>
</html>
